/*
 * Copyright 2007 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.google.gwt.sockets.client;

/**
 * The listener interface for receiving events from sockets.
 *
 * @author Aleksey Lagoshin
 */
public interface SocketListener {

  /**
   * Invoked when socket's implementation is loaded and ready to work.
   */
  public void onReady();

  /**
   * Invoked when socket has been successfully connected. 
   */
  public void onConnect();

  /**
   * Invoked when connection has been closed by some cause.
   */
  public void onCloseConnection();

  /**
   * Invoked when some data have been loaded.
   *
   * @param loadedBytes the number of bytes have been loaded
   */
  public void onData(int loadedBytes);

  /**
   * Invoked when security error occurs.
   *
   * @param message the detail message of an error
   */
  public void onSecurityError(String message);

  /**
   * Invoked when input/output error occurs.
   *
   * @param message the detail message of an error
   */
  public void onIOError(String message);

}
